home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / Watcher / Watcher.doc < prev    next >
Text File  |  1996-09-26  |  12KB  |  306 lines
  1.        ==============================================================
  2.  
  3.                - Watcher V37 - Advanced title bar watcher -
  4.  
  5.                        ©1993 by HemSoft Developments
  6.  
  7.                       - Requires KS 2.04 or higher -
  8.  
  9.        ==============================================================
  10.  
  11.  
  12.                                  Copyright
  13.                                  ---------
  14.  
  15.        Watcher V37 is Copyright by HemSoft Developments.  Watcher.LHA
  16.        may be distributed freely as long as  all  the  files  in  the
  17.        archive are left intact.
  18.  
  19.  
  20.                                 Disclaimer
  21.                                 ----------
  22.  
  23.        HemSoft Developments takes no responsibilities for the  misuse
  24.        of Watcher. The use of Watcher is strictly at your own risk.
  25.  
  26.  
  27.                                  Contents
  28.                                  --------
  29.  
  30.        Watcher contains many files, so let me  try  to  give  you  an
  31.        overview of the sub-drawers in this archive:
  32.  
  33.        ARexxScripts
  34.          This directory contains examle ARexx scripts for Watcher.
  35.  
  36.        Catalogs
  37.          Catalog description and translation files  for  Watcher.  If
  38.          you are using V37+ (!) you can use your favourite  language!
  39.          In the WatcherPrefs utility, you're able to set the langauge
  40.          you want to use  with  Watcher.  Currently  only  english  &
  41.          danish is supported.
  42.  
  43.        DataTypes
  44.          This directory contains PD datatypes for WB 3.0. With  these
  45.          datatypes installed on your system,  you  will  be  able  to
  46.          display BMP, GIF & PCX pictures from the  App  Info  utility
  47.          build into Watcher.
  48.  
  49.        DataTypesFx
  50.          This directory contains different pictures in BMP, PCX, GIF,         
  51.          HAM8 & IFF format.
  52.  
  53.        Gfx
  54.          This directory contains the brush used by App Info.
  55.  
  56.        Lib
  57.          Special object files used by Watcher.
  58.  
  59.        Libs
  60.          V34 amigaguide.library to be used  when  running  V37.  This
  61.          library is (C)opyright by Commodore Business Machines.
  62.  
  63.        Notes
  64.          Watcher related notes.
  65.  
  66.        Prefs/Env-Archive
  67.          Example Watcher.prefs to be put in ENVARC: & ENV:.
  68.  
  69.        Sources/Includes
  70.          Include files used by the Watcher sources.
  71.  
  72.        Sources/Watcher
  73.          Sources for Watcher.
  74.  
  75.        Sources/WatcherPrefs
  76.          Sources for WatcherPrefs.
  77.  
  78.        Tools
  79.          Tools used when making the Watcher app.
  80.  
  81.  
  82.                                   Purpose
  83.                                   -------
  84.  
  85.        I've always been looking for a good title-bar type of program,
  86.        which was able to give me the information  I  needed,  meaning
  87.        the free space  on  my  harddrive  partitions,  the  available
  88.        memory and the system time.
  89.  
  90.        Sure, there are a lot of these  programs,  but  if  I  finally
  91.        found a program I liked, it wasn't font  sensitive,  or  there
  92.        were some other tings that were basically wrong. So, I decided
  93.        to try and make something better, and hopefully you think I've
  94.        succeeded.
  95.  
  96.        Watcher is a little title-bar utility, which can be customized
  97.        to contain various information such as the free space on  hard
  98.        drive partitions, free memory, system time and  date  etc.  It
  99.        takes font size and overscan into account  when  opening  it's
  100.        window. Watcher can jump between public screens by clicking on
  101.        it's Zoom gadget. Furthermore, you  are  able  to  modify  the
  102.        information displayed, by invoking the  WatcherPrefs  utility,
  103.        which should be located in the SYS:Prefs drawer. This  utility
  104.        lets you customize what Watcher displays  and  how  it  should
  105.        behave. More on this issue later.
  106.  
  107.        Watcher is also able to monitor the free space of your drives,
  108.        and give you an alert whenever the free  space  goes  below  a
  109.        limit you define. This is especially useful if you're watching
  110.        network drives.
  111.  
  112.        SystemListBrowser (SLB) is an utility build into Watcher. When
  113.        you activate SLB through the menu, a window pops up containing
  114.        a cycle gadget through which you can choose to display Screen,
  115.        Library, Device, Task, Port, Resource, Font, Volume and Assign
  116.        information in the listview gadget. Clicking on an item in the
  117.        listview gives you addtional information on the  item  in  the
  118.        list.
  119.  
  120.        App Info is another utility build into  Watcher.  This  is  an
  121.        AppIcon you can drop files over in order  to  get  information
  122.        about the file. It  is  intented  especially  to  get  version
  123.        strings from executables, and displaying pictures. App Info is
  124.        datatypes aware, which enables it to display pictures  of  all
  125.        formats, as long as you have a corresponding  datatype  driver
  126.        for the specific picture. The datatypes stuff  is  only  valid
  127.        when running V39+.
  128.  
  129.        Furthermore, Watcher can be controlled from ARexx through it's
  130.        "ARexx  interface".  Currently  the  ARexx  implementation  is
  131.        rather limited.
  132.  
  133.        Watcher also registers itself  with  the  Commodities  Exhange
  134.        system, which means that you can hotkey control it through the
  135.        CX_xxx tooltypes. See the RKM  Libraries  manual  for  further
  136.        information on this subject.
  137.  
  138.  
  139.                                  Features:
  140.                                  ---------
  141.        Watcher knows about:
  142.  
  143.        - AmigaGuide.
  144.        - AppIcon.
  145.        - Asl Requesters.
  146.        - Boopsi.
  147.        - ARexx.
  148.        - Commodities.
  149.        - DataTypes. (V39)
  150.        - Gadget help. (V37 compatible)
  151.        - Locale (V37 compatible!)
  152.        - Menu help.
  153.        - NewLook menus. (V39)
  154.        - Notification.
  155.        - Pooled memory. (V39)
  156.        - Public screens.
  157.  
  158.  
  159.                                Installation
  160.                                ------------
  161.  
  162.        Copy  Watcher  to  your   SYS:WBStartup   drawer,   and   copy
  163.        WatcherPrefs to your SYS:Prefs  drawer  and  you're  ready  to
  164.        roll. You may want to edit the CX_xxx tooltypes of the Watcher
  165.        icon to conform to your needs.
  166.  
  167.                                 !IMPORTANT!
  168.  
  169.        You may NOT invoke WatcherPrefs from  within  Watcher  if  you
  170.        don't have a ENVARC:/ENV: Watcher.prefs file installed. Due to
  171.        a  bug  (which I can't seem to find)  you  must  first  invoke
  172.        WatcherPrefs from the Workbench and then save  your  settings.
  173.        After that you can invoke WatcherPrefs from within Watcher if
  174.        you like.
  175.  
  176.                              Starting Watcher
  177.                              ----------------
  178.  
  179.        Watcher can only  be  started  from  the  Workbench.  You  can
  180.        customize the  behaviour  of  Watcher  from  the  WatcherPrefs
  181.        utility. You can start the WatcherPrefs utility independant of
  182.        Watcher, or you can launch it from the menu within Watcher.
  183.  
  184.  
  185.                                WatcherPrefs
  186.                                ------------
  187.  
  188.        WatcherPrefs is the preference editor for  Watcher.  Here  you
  189.        can set all the parameters for Watcher.  As  there  is  gadget
  190.        sensitive on-line  help  from  this  program,  I'll  omit  the
  191.        documentation of this program. Whenever  you're  in  doubt  of
  192.        some features in WatcherPrefs, place the mouse pointer of  the
  193.        gadget in question and press 'HELP'. Also, during menu session
  194.        you are able to press 'HELP' to get help on a menu item.
  195.  
  196.  
  197.                             SystemListBrowser:
  198.                             ------------------
  199.  
  200.        In the Utilities menu you'll discover  the  SystemListBrowser,
  201.        which is a utility to list different system  information  such
  202.        as screens,  libraries,  devices,  tasks,  message  ports  and
  203.        resources. The cycle gadget in the top lets you toggle between
  204.        the differnt system lists. To get more information on an  item
  205.        in the listview gadget, simply click on the item.  The  bottom
  206.        gadget let's you update the display, since this  is  not  done
  207.        automatically.
  208.  
  209.                                  App Info:
  210.                                  ---------
  211.  
  212.        Another utility that can be activated from the Watcher menu is
  213.        the 'App Info' utility. This utility puts a Workbench  AppIcon
  214.        on the Workbench, and is intented to be used  with  executable
  215.        files and pictures (for now).
  216.  
  217.        There are several ways to control App Info.  You  can  double-
  218.        click on the AppIcon itself, or you can drop other icons  over
  219.        it.
  220.  
  221.        If you double-click  the  AppIcon  a  requester  will  appear,
  222.        asking you to either Quit App Info entirely, Load a  file,  or
  223.        Cancel. Hitting 'Quit' will remove the AppIcon. Hitting 'Load'
  224.        will put up the asl requester, so that you can choose  a  file
  225.        to get information on.
  226.  
  227.        If you select an executable, App Info will try to obtain  some
  228.        informaton on the executable including the version string.
  229.  
  230.        If you select a picture, and are running V39+ of the  OS,  App
  231.        Info will ask the  datatypes  system  if  it  know  the  given
  232.        picture type, if it does, App Info  will  create  a  datatypes
  233.        object in order to get information  on  the  picture  file.  A
  234.        requester is then put up, where you can choose to display  the
  235.        picture or return. If you display the  picture,  simply  press
  236.        any mouse button to return.
  237.  
  238.  
  239.                                    ARexx:
  240.                                    ------
  241.  
  242.        Watcher has an ARexx port by the name WATCHERx. The first copy
  243.        of Watcher you start will have the port name WATCHER1 the next
  244.        WATCHER2 etc. This is the port through which you  issue  ARexx
  245.        commands. Currently there are 4 supported commands available:
  246.  
  247.          GETTITLE   - Will return the current window contents.
  248.          JUMPSCREEN - Will jump to the next public screen (if any).
  249.          SHOWHELP   - Will show the help guide file.
  250.          QUIT       - Will quit Watcher.
  251.  
  252.        Please see the ARexx drawer for example ARexx scripts.
  253.  
  254.  
  255.                              Programmer Notes:
  256.                              -----------------
  257.  
  258.        You need to copy lib/simplerexx.o to  your  LIB:  drawer,  and
  259.        replace your include:clib/wb_protos.h header file with the one
  260.        supplied in the include/clib drawer. There's an error  in  the
  261.        V39  wb_protos.h  header  file  where  the  WBInfo()  function
  262.        returns void instead of ULONG. The header file  supplied  here
  263.        has been corrected for this mistake.
  264.  
  265.        Furthermore, if you haven't already got BumpRev, then copy the
  266.        BumpRev file from the Tools directory to a directory  included
  267.        in your path.
  268.  
  269.                                Bug Reports:
  270.                                ------------
  271.  
  272.        If you find any errors, have suggestions for improvements,  or
  273.        you simply would like to send a  small  donation  of  whatever
  274.        kind, then please send it to the address below:
  275.  
  276.                                Franz Hemmer
  277.                                Skolegade 21F
  278.                               8600 Silkeborg
  279.                                DK - Denmark
  280.  
  281.        If you have the option, then please send email to:
  282.  
  283.                  UseNet email: hemmer@hemmer.adsp.sub.org
  284.  
  285.        Please NOTE! that if some task corrupts your  memory,  Watcher
  286.        will most likely be blamed  first.  This  is  because  Watcher
  287.        (im most cases) constantly checks your memory with AvailMem().
  288.  
  289.  
  290.                                 Thanks to:
  291.                                 ----------
  292.  
  293.        A big thank you is due to the following beta-testers:
  294.  
  295.        Steen Jørgensen                    sraboel@srabol.adsp.sub.org
  296.        Peter Janes                     pejanes@descartes.uwaterloo.ca
  297.        Jonas Andersson                   Jonas.Andersson@ludd.luth.se
  298.        Markus Juhani Aalto                     s37732v@vipunen.hut.fi
  299.        Thanos Angelopoulos                      ang!thanos@genly.uucp
  300.        David Corn                          dcorn@tusol.cs.trinity.edu
  301.        Mickey Everts                  evermic@instruction.CS.ORST.EDU
  302.        Jukka Marin                                jmarin@messi.uku.fi
  303.        
  304.        Also thanks to those who I've  forgotten,  and  to  those  who
  305.        volunteered as beta-testers, but didn't come through.
  306.